@types/mdast

What is @types/mdast?

The @types/mdast package provides TypeScript definitions for MDAST, a syntax tree format for Markdown documents. This allows developers to work with Markdown documents in a structured way, leveraging TypeScript's type checking for better code reliability and developer experience. It's primarily used in projects where Markdown processing is involved, and TypeScript is the preferred language.

What are @types/mdast's main functionalities?

Node Type Definitions

Defines the structure of various Markdown AST nodes, such as documents (Root), paragraphs (Paragraph), and text (Text). This is useful for creating or manipulating Markdown documents programmatically.

{"import { Root, Paragraph, Text } from 'mdast';
const root: Root = {
  type: 'root',
  children: [{
    type: 'paragraph',
    children: [{
      type: 'text',
      value: 'Hello, world!'
    }]
  }]
};"}

Type Guards

Provides type guards to assert node types at runtime, facilitating the implementation of type-safe operations on Markdown AST nodes.

{"import { isRoot, isParagraph } from 'mdast';
function processNode(node: Node) {
  if (isRoot(node)) {
    console.log('Processing root node');
  } else if (isParagraph(node)) {
    console.log('Processing paragraph node');
  }
}"}

Other packages similar to @types/mdast

remark

Remark is a comprehensive Markdown processing ecosystem built on unified. It can parse, transform, and stringify Markdown documents. While @types/mdast provides type definitions for MDAST nodes, remark uses these structures to perform operations on Markdown documents, making them complementary.

unified

Unified is an interface for processing text using syntax trees, serving as the foundation for remark and rehype ecosystems. It deals with abstract syntax trees (ASTs) for various formats, including MDAST for Markdown. Unlike @types/mdast, which only provides types, unified provides a framework for parsing, transforming, and serializing text.

rehype

Rehype is part of the unified ecosystem, focusing on HTML processing. It's similar to remark but for HTML documents. While @types/mdast provides TypeScript definitions for Markdown syntax trees, rehype deals with HTML syntax trees (HAST). Both are used for structured document processing in their respective domains.

README

Installation

npm install --save @types/mdast

Summary

This package contains type definitions for mdast (https://github.com/syntax-tree/mdast).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mdast/v3.

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: @types/unist

Credits

These definitions were written by Christian Murphy, Jun Lu, Remco Haszing, and Titus Wormer.